/*********************************************************************************************************************
 * TC387 Opensourec Library 即（TC387 开源库）是一个基于官方 SDK 接口的第三方开源库
 * Copyright (c) 2022 SEEKFREE 逐飞科技
 *
 * 本文件是 TC387 开源库的一部分
 *
 * TC387 开源库 是免费软件
 * 您可以根据自由软件基金会发布的 GPL（GNU General Public License，即 GNU通用公共许可证）的条款
 * 即 GPL 的第3版（即 GPL3.0）或（您选择的）任何后来的版本，重新发布和/或修改它
 *
 * 本开源库的发布是希望它能发挥作用，但并未对其作任何的保证
 * 甚至没有隐含的适销性或适合特定用途的保证
 * 更多细节请参见 GPL
 *
 * 您应该在收到本开源库的同时收到一份 GPL 的副本
 * 如果没有，请参阅<https://www.gnu.org/licenses/>
 *
 * 额外注明：
 * 本开源库使用 GPL3.0 开源许可证协议 以上许可申明为译文版本
 * 许可申明英文版在 libraries/doc 文件夹下的 GPL3_permission_statement.txt 文件中
 * 许可证副本在 libraries 文件夹下 即该文件夹下的 LICENSE 文件
 * 欢迎各位使用并传播本程序 但修改内容时必须保留逐飞科技的版权声明（即本声明）
 *
 * 文件名称          zf_device_key
 * 公司名称          成都逐飞科技有限公司
 * 版本信息          查看 libraries/doc 文件夹内 version 文件 版本说明
 * 开发环境          ADS v1.10.2
 * 适用平台          TC387QP
 * 店铺链接          https://seekfree.taobao.com/
 *
 * 修改记录
 * 日期              作者                备注
 * 2022-11-04       pudding            first version
 * 2023-04-28       pudding            增加中文注释说明
 ********************************************************************************************************************/
/*********************************************************************************************************************
 * 接线定义：
 *                   ------------------------------------
 *                   模块管脚            单片机管脚
 *                   // 一般是主板按键对应的引脚
 *                   KEY1/S1             查看 zf_device_key.h 中 KEY_LIST[0]
 *                   KEY2/S2             查看 zf_device_key.h 中 KEY_LIST[1]
 *                   KEY3/S3             查看 zf_device_key.h 中 KEY_LIST[2]
 *                   KEY4/S4             查看 zf_device_key.h 中 KEY_LIST[3]
 *                   ------------------------------------
 ********************************************************************************************************************/

#include "zf_common_debug.h"

#include "zf_device_key.h"

static uint32 scanner_period = 0;                     // 按键的扫描周期
static uint32 key_press_time[KEY_NUMBER];             // 按键信号持续时长
static uint32 key_short_press_hold_time[KEY_NUMBER];  // 短按状态保持计时器
static key_state_enum key_state[KEY_NUMBER];          // 按键状态

static const gpio_pin_enum key_index[KEY_NUMBER] = KEY_LIST;  // 按键列表

//-------------------------------------------------------------------------------------------------------------------
// 函数简介     按键状态扫描
// 参数说明     void
// 返回参数     void
// 使用示例     key_scanner();
// 备注信息     这个函数放在主循环或者 PIT 中断中
//-------------------------------------------------------------------------------------------------------------------
void key_scanner(void)
{
    uint8 i = 0;
    for (i = 0; KEY_NUMBER > i; i++)
    {
        // 处理短按状态保持时间 - 使用长按阈值作为超时时间
        if (KEY_SHORT_PRESS == key_state[i])
        {
            key_short_press_hold_time[i]++;
            if (KEY_LONG_PRESS_PERIOD / scanner_period <= key_short_press_hold_time[i])
            {
                key_state[i] = KEY_RELEASE;  // 短按状态超时，自动清除
                key_short_press_hold_time[i] = 0;
            }
        }

        if (KEY_RELEASE_LEVEL != gpio_get_level(key_index[i]))  // 按键按下
        {
            key_press_time[i]++;
            if (KEY_LONG_PRESS_PERIOD / scanner_period <= key_press_time[i])
            {
                key_state[i] = KEY_LONG_PRESS;
                key_short_press_hold_time[i] = 0;  // 清除短按保持计时器
            }
        }
        else  // 按键释放
        {
            if ((KEY_LONG_PRESS != key_state[i]) &&
                (KEY_SHORT_PRESS != key_state[i]) &&  // 如果当前不是短按状态保持期
                (KEY_MAX_SHOCK_PERIOD / scanner_period <= key_press_time[i]) &&
                (KEY_LONG_PRESS_PERIOD / scanner_period > key_press_time[i]))
            {
                key_state[i] = KEY_SHORT_PRESS;
                key_short_press_hold_time[i] = 0;  // 重置短按保持计时器
            }
            else if (KEY_SHORT_PRESS != key_state[i])  // 如果不是短按保持期，才清除状态
            {
                key_state[i] = KEY_RELEASE;
            }
            key_press_time[i] = 0;
        }
    }
}

//-------------------------------------------------------------------------------------------------------------------
// 函数简介     获取按键状态
// 参数说明     key_n           按键索引
// 返回参数     key_state_enum  按键状态
// 使用示例     key_get_state(KEY_1);
// 备注信息     获取到短按状态时会自动清除该状态，避免重复触发
//-------------------------------------------------------------------------------------------------------------------
key_state_enum key_get_state(key_index_enum key_n)
{
    key_state_enum current_state = key_state[key_n];
    if (KEY_SHORT_PRESS == current_state)
    {
        key_state[key_n] = KEY_RELEASE;        // 获取短按状态时自动清除
        key_short_press_hold_time[key_n] = 0;  // 清除短按保持计时器
    }
    return current_state;
}

//-------------------------------------------------------------------------------------------------------------------
// 函数简介     获取按键状态并自动清除短按状态
//-------------------------------------------------------------------------------------------------------------------
// 函数简介     清除指定按键状态
// 参数说明     key_n           按键索引
// 返回参数     void            无
// 使用示例     key_clear_state(KEY_1);
// 备注信息     手动清除按键状态，包括短按保持时间
//-------------------------------------------------------------------------------------------------------------------
void key_clear_state(key_index_enum key_n)
{
    key_state[key_n] = KEY_RELEASE;
    key_short_press_hold_time[key_n] = 0;  // 同时清除短按保持计时器
}

//-------------------------------------------------------------------------------------------------------------------
// 函数简介     清除所有按键状态
// 参数说明     void            无
// 返回参数     void            无
// 使用示例     key_clear_all_state();
// 备注信息     清除所有按键状态和短按保持计时器
//-------------------------------------------------------------------------------------------------------------------
void key_clear_all_state(void)
{
    uint8 i = 0;
    for (i = 0; KEY_NUMBER > i; i++)
    {
        key_state[i] = KEY_RELEASE;
        key_short_press_hold_time[i] = 0;
    }
}

//-------------------------------------------------------------------------------------------------------------------
// 函数简介     按键初始化
// 参数说明     period          按键扫描周期 以毫秒为单位
// 返回参数     void
// 使用示例     key_init(10);
// 备注信息     初始化所有按键GPIO和状态变量
//-------------------------------------------------------------------------------------------------------------------
void key_init(uint32 period)
{
    zf_assert(0 < period);
    uint8 loop_temp = 0;
    for (loop_temp = 0; KEY_NUMBER > loop_temp; loop_temp++)
    {
        gpio_init(key_index[loop_temp], GPI, GPIO_HIGH, GPI_PULL_UP);
        key_state[loop_temp] = KEY_RELEASE;
        key_short_press_hold_time[loop_temp] = 0;  // 初始化短按保持计时器
    }
    scanner_period = period;
}
